#region The MIT License
// The MIT License
// 
// Copyright (c) 2011 octalforty studios
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#endregion
using octalforty.Staytuned.ObjectModel;

namespace octalforty.Staytuned.ComponentModel
{
    /// <summary>
    /// Provides functionality for transforming <see cref="Notification"/> instances into implementation-specific <see cref="Message"/> objects.
    /// </summary>
    public interface IMessageFormatter
    {
        /// <summary>
        /// Formats <paramref name="notification"/> according to <paramref name="template"/>.
        /// </summary>
        /// <param name="template"></param>
        /// <param name="notification"></param>
        /// <param name="eventDescriptor"></param>
        /// <param name="recipient"></param>
        /// <returns></returns>
        Message FormatMessage(Template template, Notification notification, string eventDescriptor, RecipientDescriptor recipient);
    }
}